home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SLGetPrinterList.z / SLGetPrinterList
Encoding:
Text File  |  2002-10-03  |  8.7 KB  |  198 lines
  1.  
  2.  
  3.  
  4. SSSSLLLLGGGGeeeettttPPPPrrrriiiinnnntttteeeerrrrLLLLiiiisssstttt((((3333))))              IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo               SSSSLLLLGGGGeeeettttPPPPrrrriiiinnnntttteeeerrrrLLLLiiiisssstttt((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SLGetPrinterList, SLGetPrinterInfo - get printer information
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssppppoooooooollll....hhhh>>>>
  13.  
  14.      iiiinnnntttt SSSSLLLLGGGGeeeettttPPPPrrrriiiinnnntttteeeerrrrLLLLiiiisssstttt((((SSSSLLLLPPPPrrrriiiinnnntttteeeerrrrSSSSttttrrrruuuucccctttt ****pppprrrriiiinnnntttteeeerrrrsssspppp[[[[]]]],,,,
  15.                           iiiinnnntttt ****nnnnuuuummmm____pppprrrriiiinnnntttteeeerrrrsssspppp))));;;;
  16.      iiiinnnntttt SSSSLLLLGGGGeeeettttPPPPrrrriiiinnnntttteeeerrrrIIIInnnnffffoooo((((ccccoooonnnnsssstttt cccchhhhaaaarrrr ****pppprrrriiiinnnntttteeeerrrr,,,,
  17.                           SSSSLLLLPPPPrrrriiiinnnntttteeeerrrrSSSSttttrrrruuuucccctttt ********ppppiiiinnnnffffoooo))));;;;
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      _S_L_G_e_t_P_r_i_n_t_e_r_L_i_s_t returns a list of the printers registered with the
  21.      default spooling system.  _p_r_i_n_t_e_r_s_p is set by the function to point to a
  22.      list of _S_L_P_r_i_n_t_e_r_S_t_r_u_c_t structures. These structures contain detailed
  23.      information about each printer.  _n_u_m__p_r_i_n_t_e_r_s_p is set to the number of
  24.      printers in the list.  The returned list of printers is sorted
  25.      alphabetically according to the _l_o_c_a_l__n_a_m_e field. The sort is case
  26.      independent.
  27.  
  28.      _S_L_G_e_t_P_r_i_n_t_e_r_I_n_f_o returns information about a single printer.  _p_r_i_n_t_e_r
  29.      specifies the name of the printer for which information is desired. If
  30.      _p_r_i_n_t_e_r is NNNNUUUULLLLLLLL, the default printer will be used.  _p_i_n_f_o is set by the
  31.      function to point to a _S_L_P_r_i_n_t_e_r_S_t_r_u_c_t structure containing the
  32.      information about the printer.
  33.  
  34.      The _S_L_P_r_i_n_t_e_r_S_t_r_u_c_t is defined as:
  35.  
  36.           typedef struct _slPrinterStruct {
  37.               char *local_name;             /* Local printer name       */
  38.               char *formal_name;            /* Formal printer name      */
  39.               char *type;                   /* Printer type (eg. Color) */
  40.               char *dev;                    /* Port name (eg. /dev/plp) */
  41.               unsigned int is_def: 1;       /* 1 == default printer     */
  42.               unsigned int is_class: 1;     /* 1 == printer is class    */
  43.               unsigned int is_networked: 1; /* 1 == network printer     */
  44.               unsigned int _padding: 29;    /* Unused - for alignment   */
  45.               char *remote_host;            /* Remote machine name      */
  46.               char *remote_name;            /* Remote printer name      */
  47.               char *network_type;           /* Remote machine type      */
  48.           } SLPrinterStruct;
  49.  
  50.  
  51. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  52.      0 is returned if execution was successful. -1 is returned and _S_L_e_r_r_n_o is
  53.      set if an execution error has occurred.
  54.  
  55. EEEEXXXXEEEECCCCUUUUTTTTIIIIOOOONNNN EEEERRRRRRRROOOORRRR CCCCOOOODDDDEEEESSSS
  56.      _S_L_G_e_t_P_r_i_n_t_e_r_L_i_s_t and _S_L_G_e_t_P_r_i_n_t_e_r_I_n_f_o will fail under the following
  57.      circumstances.
  58.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. SSSSLLLLGGGGeeeettttPPPPrrrriiiinnnntttteeeerrrrLLLLiiiisssstttt((((3333))))              IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo               SSSSLLLLGGGGeeeettttPPPPrrrriiiinnnntttteeeerrrrLLLLiiiisssstttt((((3333))))
  70.  
  71.  
  72.  
  73.      SL_ERR_FIND_SPOOLER      An error occurred while attempting to determine
  74.                               the available printer spooling systems.
  75.  
  76.      SL_ERR_NO_SPOOLERS       There are no printer spooling systems available.
  77.  
  78.  
  79.      In addition, _S_L_G_e_t_P_r_i_n_t_e_r_I_n_f_o will fail under the following conditions.
  80.  
  81.      SL_ERR_NO_DEF_PRINTER    There is no default printer registered with the
  82.                               printer spooling system.
  83.  
  84.      SL_ERR_BAD_PRINTER_NAME  The printer name specified is either an empty
  85.                               string (""), or a string consisting entirely of
  86.                               whitespace.
  87.  
  88.      SL_ERR_BAD_CLASS_MEMBER  The specified printer class contains an invalid
  89.                               printer.
  90.  
  91. WWWWAAAARRRRNNNNIIIINNNNGGGG
  92.      A pointer to _p_r_i_n_t_e_r_s_p obtained by a previous call to _S_L_G_e_t_P_r_i_n_t_e_r_L_i_s_t
  93.      will be invalid after subsequent calls to the function. The contents of
  94.      the printer list _p_r_i_n_t_e_r_s_p must be copied to be preserved. Note that the
  95.      character string fields of the structure must be duplicated in any copy
  96.      operation since these pointers also become invalid. Similarly, the
  97.      contents of the structure pointed to by _p_i_n_f_o will not be preserved
  98.      across calls to _S_L_G_e_t_P_r_i_n_t_e_r_I_n_f_o.
  99.  
  100. NNNNOOOOTTTTEEEESSSS
  101.      The following notes refer to BSD and System V systems to indicate the use
  102.      of the BSD and System V printer spooling systems respectively. All
  103.      mention of "fields" refers to the fields of the _S_L_P_r_i_n_t_e_r_S_t_r_u_c_t
  104.      structure.
  105.  
  106.      1.   On BSD systems it is assumed that the _f_o_r_m_a_l__n_a_m_e field is the last
  107.           printer name to appear in the /_e_t_c/_p_r_i_n_t_c_a_p entry printer name list.
  108.  
  109.      2.   On any spooling system, if the _f_o_r_m_a_l__n_a_m_e cannot be determined it
  110.           will be set to the value of _t_y_p_e.
  111.  
  112.      3.   On BSD systems the printer type (_t_y=) may not be specified in the
  113.           /_e_t_c/_p_r_i_n_t_c_a_p file entry for the printer. In that case the _t_y_p_e
  114.           field will be set to the string "Unknown".
  115.  
  116.      4.   If a printer is not physically connected to the user's workstation,
  117.           but is accessed over the network, the printer is called a networked
  118.           printer. If a printer is networked, the _d_e_v field will be set to a
  119.           NNNNUUUULLLLLLLL pointer.
  120.  
  121.      5.   If the printer is physically connected to the user's workstation, it
  122.           is called a local printer. If a printer is local, the _r_e_m_o_t_e__h_o_s_t,
  123.           _r_e_m_o_t_e__n_a_m_e, and _n_e_t_w_o_r_k__t_y_p_e fields will be set to the NNNNUUUULLLLLLLL
  124.           pointer.
  125.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135. SSSSLLLLGGGGeeeettttPPPPrrrriiiinnnntttteeeerrrrLLLLiiiisssstttt((((3333))))              IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo               SSSSLLLLGGGGeeeettttPPPPrrrriiiinnnntttteeeerrrrLLLLiiiisssstttt((((3333))))
  136.  
  137.  
  138.  
  139.      6.   On BSD systems one physical printer can be referred to by many
  140.           names.  Therefore, it is possible for more than one printer in the
  141.           printer list to be marked as the default printer (i.e. _d_e_f = 1).
  142.  
  143.      7.   On System V systems the _i_s__c_l_a_s_s field is set to 1 if the printer is
  144.           actually a printer class rather than an actual physical printer. On
  145.           BSD systems this field is always set to 0.
  146.  
  147. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  148.      SLGetDefPrinterName(3), SLPerror(3), libspool(3)
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                                                         PPPPaaaaggggeeee 3333
  195.  
  196.  
  197.  
  198.